Skip to content

Enhancement - Optimise CNSFileAccessConfig reconciliation workflow #3647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 8, 2025
Merged

Enhancement - Optimise CNSFileAccessConfig reconciliation workflow #3647

merged 1 commit into from
Oct 8, 2025
+79 −76

Conversation

kolluria
Copy link
Contributor

@kolluria kolluria commented Oct 5, 2025 •
edited
Loading

What this PR does / why we need it

Updates CNSFileAccessConfig reconciler to use status subresource endpoint to update status to avoid unintentional and unnecessary generation increments.
Updates the reconciler to ignore events that do not have a change in the generation number.

Testing done

In case of multiple reconciliations of an instance

Created some dummy CRs and verified that the generation is unchanged in multiple reconciles

List CR output 

apiVersion: v1
items:
- apiVersion: cns.vmware.com/v1alpha1
  kind: CnsFileAccessConfig
  metadata:
    annotations:
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"cns.vmware.com/v1alpha1","kind":"CnsFileAccessConfig","metadata":{"annotations":{},"name":"cns-file-access-config-1","namespace":"cns-file-access-config"},"spec":{"pvcName":"pvc-1","vmName":"vm-1"}}
    creationTimestamp: "2025-10-06T09:02:30Z"
    generation: 1
    name: cns-file-access-config-1
    namespace: cns-file-access-config
    resourceVersion: "744166"
    uid: 681b5340-ada8-4053-a34e-df6e8b08bbf3
  spec:
    pvcName: pvc-1
    vmName: vm-1
  status:
    error: 'Failed to get virtualmachine instance for the VM with name: "vm-1". Error:
      virtualmachines.vmoperator.vmware.com "vm-1" not found'
- apiVersion: cns.vmware.com/v1alpha1
  kind: CnsFileAccessConfig
  metadata:
    annotations:
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"cns.vmware.com/v1alpha1","kind":"CnsFileAccessConfig","metadata":{"annotations":{},"name":"cns-file-access-config-10","namespace":"cns-file-access-config"},"spec":{"pvcName":"pvc-10","vmName":"vm-10"}}
    creationTimestamp: "2025-10-06T09:02:49Z"
    generation: 1
    name: cns-file-access-config-10
    namespace: cns-file-access-config
    resourceVersion: "744399"
    uid: 5993477b-7366-4e6c-b6ca-ac1b4796a2d0
  spec:
    pvcName: pvc-10
    vmName: vm-10
  status:
    error: 'Failed to get virtualmachine instance for the VM with name: "vm-10". Error:
      virtualmachines.vmoperator.vmware.com "vm-10" not found'
- apiVersion: cns.vmware.com/v1alpha1
  kind: CnsFileAccessConfig
  metadata:
    annotations:
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"cns.vmware.com/v1alpha1","kind":"CnsFileAccessConfig","metadata":{"annotations":{},"name":"cns-file-access-config-2","namespace":"cns-file-access-config"},"spec":{"pvcName":"pvc-2","vmName":"vm-2"}}
    creationTimestamp: "2025-10-06T09:02:32Z"
    generation: 1
    name: cns-file-access-config-2
    namespace: cns-file-access-config
    resourceVersion: "744189"
    uid: a951b47b-cda0-4604-ac69-744e48b537ef
  spec:
    pvcName: pvc-2
    vmName: vm-2
  status:
    error: 'Failed to get virtualmachine instance for the VM with name: "vm-2". Error:
      virtualmachines.vmoperator.vmware.com "vm-2" not found'
- apiVersion: cns.vmware.com/v1alpha1
  kind: CnsFileAccessConfig
  metadata:
    annotations:
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"cns.vmware.com/v1alpha1","kind":"CnsFileAccessConfig","metadata":{"annotations":{},"name":"cns-file-access-config-3","namespace":"cns-file-access-config"},"spec":{"pvcName":"pvc-3","vmName":"vm-3"}}
    creationTimestamp: "2025-10-06T09:02:34Z"
    generation: 1
    name: cns-file-access-config-3
    namespace: cns-file-access-config
    resourceVersion: "744213"
    uid: 627aa3dc-9b81-4830-907c-6374eba309ac
  spec:
    pvcName: pvc-3
    vmName: vm-3
  status:
    error: 'Failed to get virtualmachine instance for the VM with name: "vm-3". Error:
      virtualmachines.vmoperator.vmware.com "vm-3" not found'
- apiVersion: cns.vmware.com/v1alpha1
  kind: CnsFileAccessConfig
  metadata:
    annotations:
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"cns.vmware.com/v1alpha1","kind":"CnsFileAccessConfig","metadata":{"annotations":{},"name":"cns-file-access-config-4","namespace":"cns-file-access-config"},"spec":{"pvcName":"pvc-4","vmName":"vm-4"}}
    creationTimestamp: "2025-10-06T09:02:36Z"
    generation: 1
    name: cns-file-access-config-4
    namespace: cns-file-access-config
    resourceVersion: "744240"
    uid: 412781a7-8c5d-47d0-839b-5d07bee14d91
  spec:
    pvcName: pvc-4
    vmName: vm-4
  status:
    error: 'Failed to get virtualmachine instance for the VM with name: "vm-4". Error:
      virtualmachines.vmoperator.vmware.com "vm-4" not found'
- apiVersion: cns.vmware.com/v1alpha1
  kind: CnsFileAccessConfig
  metadata:
    annotations:
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"cns.vmware.com/v1alpha1","kind":"CnsFileAccessConfig","metadata":{"annotations":{},"name":"cns-file-access-config-5","namespace":"cns-file-access-config"},"spec":{"pvcName":"pvc-5","vmName":"vm-5"}}
    creationTimestamp: "2025-10-06T09:02:38Z"
    generation: 1
    name: cns-file-access-config-5
    namespace: cns-file-access-config
    resourceVersion: "744265"
    uid: 49935c1c-b350-4a7d-8cce-3501468e4be2
  spec:
    pvcName: pvc-5
    vmName: vm-5
  status:
    error: 'Failed to get virtualmachine instance for the VM with name: "vm-5". Error:
      virtualmachines.vmoperator.vmware.com "vm-5" not found'
kind: List
metadata:
  resourceVersion: ""

Delete workflow 

> kc delete cnsfileaccessconfigs --all
cnsfileaccessconfig.cns.vmware.com "cns-file-access-config-1" deleted
cnsfileaccessconfig.cns.vmware.com "cns-file-access-config-2" deleted
cnsfileaccessconfig.cns.vmware.com "cns-file-access-config-3" deleted
cnsfileaccessconfig.cns.vmware.com "cns-file-access-config-4" deleted
cnsfileaccessconfig.cns.vmware.com "cns-file-access-config-5" deleted

> kc get cnsfileaccessconfigs
No resources found in cns-file-access-config namespace.

Provision and attach RWX PVC in a guest cluster

  1. Created a RWX PVC in a guest cluster and attached it to a pod
  2. Verified that CNSFileAccessConfig CR got created successfully and the Pod came to running state
apiVersion: cns.vmware.com/v1alpha1
kind: CnsFileAccessConfig
metadata:
  creationTimestamp: "2025-10-08T07:42:44Z"
  finalizers:
  - cns.vmware.com
  generation: 1
  name: test-cluster-e2e-script-node-pool-1-4n6wq-4825v-22nhz-869b5308-523b-46bf-b966-c34e7dfa63fd-c86b89c1-10a8-4eb2-8d9e-8eb8a3a6650c
  namespace: test-gc-e2e-demo-ns
  ownerReferences:
  - apiVersion: vmoperator.vmware.com/v1alpha5
    blockOwnerDeletion: true
    controller: true
    kind: VirtualMachine
    name: test-cluster-e2e-script-node-pool-1-4n6wq-4825v-22nhz
    uid: 0fba6df1-1275-4056-a390-8c79d4f62ab0
  resourceVersion: "675990"
  uid: cabbece1-2d0d-4b7c-a887-14caf2ab955e
spec:
  pvcName: 869b5308-523b-46bf-b966-c34e7dfa63fd-c86b89c1-10a8-4eb2-8d9e-8eb8a3a6650c
  vmName: test-cluster-e2e-script-node-pool-1-4n6wq-4825v-22nhz
status:
  accessPoints:
    NFSv3: host13.cibgst.com:/527d5c31-26c0-36bb-5117-8e30377882a3
    NFSv4.1: host10.cibgst.com:/vsanfs/527d5c31-26c0-36bb-5117-8e30377882a3
  done: true
  1. Delete the Pod and verified that the CR got deleted too
> kubectl -n cns-file-access-config get cnsfileaccessconfigs
No resources found in test-gc-e2e-demo-ns namespace.

Observations:

The behaviour of the reconciler is as expected in all the cases and the generation of the CRs remained at 1.

Special notes for your reviewer:

Release note:

Optimize CNSFileAccessConfig reconciliation workflow

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 5, 2025
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 5, 2025
@kolluria kolluria force-pushed the refactor_cns_file_access_config branch from 104bc28 to 6e47686 Compare October 7, 2025 07:25
@kolluria kolluria marked this pull request as ready for review October 7, 2025 07:28
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 7, 2025
@kolluria
Copy link
Contributor Author

kolluria commented Oct 7, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Oct 7, 2025
@kolluria
Copy link
Contributor Author

kolluria commented Oct 7, 2025

/assign @kolluria

@kolluria
Copy link
Contributor Author

kolluria commented Oct 7, 2025

WCP Precheckin - #435
VKS Precheckin - #458

@deepakkinni
Copy link
Collaborator

SUCCESS --- Jenkins Build #435

@deepakkinni
Copy link
Collaborator

SUCCESS --- Jenkins Build #459

@kolluria kolluria force-pushed the refactor_cns_file_access_config branch from 6e47686 to 862388b Compare October 8, 2025 07:47
@kolluria
Copy link
Contributor Author

kolluria commented Oct 8, 2025

/retest

@kolluria
Copy link
Contributor Author

kolluria commented Oct 8, 2025

/test pull-vsphere-csi-driver-verify-golangci-lint

@kolluria kolluria force-pushed the refactor_cns_file_access_config branch from 862388b to 0214892 Compare October 8, 2025 13:24
@kolluria
Enhancement - Optimise CNSFileAccessConfig reconciliation workflow
d2b1f0d 
Updated reconciler to use status subresource endpoint to update status
Updated reconciler to ignore updates without any generation change
@kolluria kolluria force-pushed the refactor_cns_file_access_config branch from 0214892 to d2b1f0d Compare October 8, 2025 13:24
@kolluria kolluria mentioned this pull request Oct 8, 2025
Closed
divyenpatel
divyenpatel approved these changes Oct 8, 2025
View reviewed changes
Copy link
Member

@divyenpatel divyenpatel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 8, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: divyenpatel, kolluria

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [divyenpatel,kolluria]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 1a0b8f2 into kubernetes-sigs:master Oct 8, 2025
12 checks passed
@kolluria kolluria deleted the refactor_cns_file_access_config branch October 8, 2025 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@divyenpatel divyenpatel divyenpatel approved these changes

@chethanv28 chethanv28 Awaiting requested review from chethanv28

@deepakkinni deepakkinni Awaiting requested review from deepakkinni

Assignees

@divyenpatel divyenpatel

@kolluria kolluria

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kolluria @k8s-ci-robot @deepakkinni @divyenpatel